Implement Get all mentors endpoint (Admin) #24 #67

sathudeva7 · 2023-10-04T18:07:39Z

Purpose

The purpose of this PR is to fix #24

Goals

This issue involves implementing an API to get all mentors. The endpoint should allow Admin to make a GET request to {{baseUrl}}/api/admin/mentors?status={{status}}.

Approach

```const mentorsList: Mentor[] = await mentorRepository.find({
  where: { state: status },
  select: [
    'application',
    'availability',
    'state',
    'created_at',
    'updated_at'
  ],
  relations: ['profile', 'category']
})

This api endpoint request application json in a different format so created a function with switch case according to json question function return specific key for the application object in the response

### Screenshots
<!---  Include an animated GIF or screenshot if the change affects the UI.  -->
![Screenshot 2023-10-04 at 12 46 32](https://github.com/sef-global/scholarx-backend/assets/67930416/18daa379-b961-418a-8cb9-e7c4316e8956)


##  Checklist
- [x] This PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
- [x] I have read and understood the development best practices guidelines ( http://bit.ly/sef-best-practices )
- [ ] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation

## Related PRs
<!--- List any other related PRs --> 

## Test environment
<!--- List all versions, operating systems, databases, and browser/versions on which this feature/fix was tested --> 

## Learning
<!--- Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem. -->

sathudeva7 · 2023-10-04T18:12:10Z

anjula-sack · 2023-10-07T08:11:16Z

src/services/admin/mentor.service.test.ts

+let adminAgent: supertest.SuperAgentTest
+let mentorId: string
+
+describe('getAllMentors function', () => {


This should be route testing. Move to the src/routes/admin/mentor/mentor.route.test.ts file

anjula-sack · 2023-10-07T08:13:40Z

src/services/admin/mentor.service.ts

+  status: ApplicationStatus
+): Promise<{
+  statusCode: number
+  mentors?: AllMentorsArray[]


We do have the Mentor interface. Use that.

Suggested change

mentors?: AllMentorsArray[]

mentors?: Mentor[]

anjula-sack · 2023-10-07T08:14:35Z

src/services/admin/mentor.service.ts

+    const mentorRepository = dataSource.getRepository(Mentor)
+
+    const mentorsList: Mentor[] = await mentorRepository.find({
+      where: { state: status },


Status is optional, by default it will return all the mentors if the status is not present

src/services/admin/mentor.service.ts

anjula-sack · 2023-10-07T08:16:33Z

src/services/admin/mentor.service.ts

+    const mentors: AllMentorsArray[] = mentorsList.map((mentor, i) => {
+      Object.entries(mentor.application).map((item) => {
+        switchQuestion(item, applicationFormat)
+      })
+      return {
+        ...mentor,
+        mentor_id: i + 1,
+        application: applicationFormat,
+        category: mentor.category.category,
+        state: mentor.state.toUpperCase()


No need for this as well. Just return the mentors

Suggested change

const mentors: AllMentorsArray[] = mentorsList.map((mentor, i) => {

Object.entries(mentor.application).map((item) => {

switchQuestion(item, applicationFormat)

})

return {

...mentor,

mentor_id: i + 1,

application: applicationFormat,

category: mentor.category.category,

state: mentor.state.toUpperCase()

src/types.ts

src/routes/admin/mentor/mentor.route.test.ts

src/controllers/admin/mentor.controller.ts

src/routes/admin/mentor/mentor.route.test.ts

anjula-sack

Good job! @sathudeva7

Implement Get all mentors endpoint (Admin) sef-global#24 (sef-global#67)

Implement Get all mentors endpoint (Admin) sef-global#24

ee7c77b

sathudeva7 marked this pull request as draft October 4, 2023 18:08

sathudeva7 marked this pull request as ready for review October 4, 2023 18:08

anjula-sack requested changes Oct 7, 2023

View reviewed changes

Resolved mentioned issues

ffe92b7

anjula-sack requested changes Oct 7, 2023

View reviewed changes

src/types.ts Outdated Show resolved Hide resolved

src/routes/admin/mentor/mentor.route.test.ts Outdated Show resolved Hide resolved

src/controllers/admin/mentor.controller.ts Outdated Show resolved Hide resolved

Removed mentoInfo type and status check added

26a9b7d

anjula-sack requested changes Oct 8, 2023

View reviewed changes

src/routes/admin/mentor/mentor.route.test.ts Show resolved Hide resolved

Get all mentors without status test implemented

8801c20

anjula-sack approved these changes Oct 8, 2023

View reviewed changes

anjula-sack merged commit 6764e21 into sef-global:main Oct 8, 2023
1 check passed

sathudeva7 added a commit to sathudeva7/scholarx-backend that referenced this pull request Oct 8, 2023

Merge pull request #1 from sef-global/main

99ccd6a

Implement Get all mentors endpoint (Admin) sef-global#24 (sef-global#67)

anjula-sack pushed a commit to anjula-sack/scholarx-backend that referenced this pull request Jul 23, 2024

Implement the admin dashboard UI (sef-global#67)

fbac897

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Get all mentors endpoint (Admin) #24 #67

Implement Get all mentors endpoint (Admin) #24 #67

sathudeva7 commented Oct 4, 2023

sathudeva7 commented Oct 4, 2023

anjula-sack Oct 7, 2023

anjula-sack Oct 7, 2023

anjula-sack Oct 7, 2023

anjula-sack Oct 7, 2023

anjula-sack left a comment

Implement Get all mentors endpoint (Admin) #24 #67

Implement Get all mentors endpoint (Admin) #24 #67

Conversation

sathudeva7 commented Oct 4, 2023

Purpose

Goals

Approach

sathudeva7 commented Oct 4, 2023

anjula-sack Oct 7, 2023

Choose a reason for hiding this comment

anjula-sack Oct 7, 2023

Choose a reason for hiding this comment

anjula-sack Oct 7, 2023

Choose a reason for hiding this comment

anjula-sack Oct 7, 2023

Choose a reason for hiding this comment

anjula-sack left a comment

Choose a reason for hiding this comment